<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C MIP-SDK: mip_sdk_base.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">C MIP-SDK
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">mip_sdk_base.h</div>  </div>
</div>
<div class="contents">
<a href="mip__sdk__base_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment"></span><span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment"></span><span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// External dependencies:</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">//  </span>
<a name="l00012"></a>00012 <span class="comment">// </span>
<a name="l00014"></a>00014 <span class="comment"></span><span class="comment">//</span>
<a name="l00017"></a>00017 <span class="comment"></span><span class="comment">//</span>
<a name="l00027"></a>00027 <span class="comment"></span><span class="comment">//</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _MIP_BASE_DESC_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define _MIP_BASE_DESC_H</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 
<a name="l00035"></a>00035 <span class="comment">//</span>
<a name="l00036"></a>00036 <span class="comment">//Include Files</span>
<a name="l00037"></a>00037 <span class="comment">//</span>
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include &quot;<a class="code" href="mip_8h.html">mip.h</a>&quot;</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include &quot;<a class="code" href="mip__sdk__interface_8h.html">mip_sdk_interface.h</a>&quot;</span>
<a name="l00042"></a>00042 
<a name="l00044"></a>00044 <span class="comment">//</span>
<a name="l00045"></a>00045 <span class="comment">// Defines</span>
<a name="l00046"></a>00046 <span class="comment">//</span>
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 
<a name="l00052"></a>00052 <span class="comment">//</span>
<a name="l00053"></a>00053 <span class="comment">// Descriptor Set designator - used in the Desc Set field of the MIP header</span>
<a name="l00054"></a>00054 <span class="comment">//</span>
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="preprocessor">#define MIP_BASE_COMMAND_DESC_SET                                               0x01</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span>
<a name="l00060"></a>00060 <span class="comment">// BASE COMMAND DESCRIPTORS (command desc are &lt; 0x80)</span>
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="preprocessor">#define MIP_CMD_DESC_BASE_PING                                          0x01     </span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_SET_TO_IDLE                                   0x02     </span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_GET_DEVICE_INFO               0x03     </span>
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_GET_DEVICE_DESCRIPTORS        0x04     </span>
<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_BUILT_IN_TEST                 0x05    </span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_RESUME                                        0x06</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span>
<a name="l00070"></a>00070 <span class="preprocessor">#define MIP_CMD_DESC_BASE_GPS_TIME_BROADCAST            0x71</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_FIRMWARE_UPDATE               0x7D     </span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_SOFT_RESET                    0x7E     </span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_DESC_BASE_PRODUCTION_TEST               0x7F     </span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>
<a name="l00076"></a>00076 <span class="comment">// BASE REPLY DESCRIPTORS (reply desc are &gt;= 0x80)</span>
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="preprocessor">#define MIP_REPLY_DESC_BASE_DEVICE_INFO                                 0x81    </span>
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor">#define MIP_REPLY_DESC_BASE_DEVICE_DESCRIPTORS                  0x82    </span>
<a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor">#define MIP_REPLY_DESC_BASE_BUILT_IN_TEST                       0x83    </span>
<a name="l00082"></a>00082 <span class="preprocessor"></span>
<a name="l00083"></a>00083 
<a name="l00085"></a>00085 <span class="comment">// COMMAND SECURITY VALUES</span>
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="preprocessor">#define MIP_CMD_FIRMWARE_UPDATE_SECURITY_VAL            0x374EA822</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor">#define MIP_CMD_PRODUCTION_TEST_SECURITY_VAL            0xD3C4A133</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span>
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 
<a name="l00095"></a>00095 <span class="comment">//</span>
<a name="l00096"></a>00096 <span class="comment">// Structures</span>
<a name="l00097"></a>00097 <span class="comment">//</span>
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="preprocessor">#pragma pack(1)</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span>
<a name="l00102"></a>00102 <span class="preprocessor">#define BASE_DEVICE_INFO_PARAM_LENGTH 8  // 8 x 16 bits (16 characters)</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span>
<a name="l00105"></a>00105 <span class="comment">// Device Information</span>
<a name="l00107"></a>00107 <span class="comment"></span>
<a name="l00108"></a><a class="code" href="struct__base__device__info__field.html">00108</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__base__device__info__field.html">_base_device_info_field</a>
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110  u16 firmware_version;
<a name="l00111"></a>00111  u16 model_name[BASE_DEVICE_INFO_PARAM_LENGTH];
<a name="l00112"></a>00112  u16 model_number[BASE_DEVICE_INFO_PARAM_LENGTH];
<a name="l00113"></a>00113  u16 serial_number[BASE_DEVICE_INFO_PARAM_LENGTH];
<a name="l00114"></a>00114  u16 lotnumber[BASE_DEVICE_INFO_PARAM_LENGTH];
<a name="l00115"></a>00115  u16 device_options[BASE_DEVICE_INFO_PARAM_LENGTH];
<a name="l00116"></a>00116 }<a class="code" href="struct__base__device__info__field.html">base_device_info_field</a>;
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="preprocessor">#pragma pack()</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span>
<a name="l00120"></a>00120 
<a name="l00122"></a>00122 <span class="comment">//</span>
<a name="l00123"></a>00123 <span class="comment">// Function Prototypes</span>
<a name="l00124"></a>00124 <span class="comment">//</span>
<a name="l00126"></a>00126 <span class="comment"></span>
<a name="l00127"></a>00127 
<a name="l00128"></a>00128 u16 <a class="code" href="mip__sdk__base_8h.html#a6a16dddaf7cf73726c973a214a08b0e9">mip_base_cmd_ping</a>(<a class="code" href="struct__mip__interface.html">mip_interface</a> *device_interface);
<a name="l00129"></a>00129 u16 <a class="code" href="mip__sdk__base_8h.html#acd13d2cbe5c4f53beb3d8383b0121a2e">mip_base_cmd_idle</a>(<a class="code" href="struct__mip__interface.html">mip_interface</a> *device_interface);
<a name="l00130"></a>00130 u16 <a class="code" href="mip__sdk__base_8h.html#a4f5f257cf2122bd84858545fa065ed36">mip_base_cmd_get_device_info</a>(<a class="code" href="struct__mip__interface.html">mip_interface</a> *device_interface, <a class="code" href="struct__base__device__info__field.html">base_device_info_field</a> *device_info);
<a name="l00131"></a>00131 u16 <a class="code" href="mip__sdk__base_8h.html#ab8834fea90e0f72aa125d94e3f82f019">mip_base_cmd_get_device_supported_descriptors</a>(<a class="code" href="struct__mip__interface.html">mip_interface</a> *device_interface, u8 *response_buffer, u16 *response_size);
<a name="l00132"></a>00132 u16 <a class="code" href="mip__sdk__base_8h.html#ac7472af591013b43f17a8efcfc22dfb1">mip_base_cmd_built_in_test</a>(<a class="code" href="struct__mip__interface.html">mip_interface</a> *device_interface, u32 *bit_result);
<a name="l00133"></a>00133 u16 <a class="code" href="mip__sdk__base_8h.html#a2e62aaa38cc37952d08741f933cee489">mip_base_cmd_resume</a>(<a class="code" href="struct__mip__interface.html">mip_interface</a> *device_interface);
<a name="l00134"></a>00134 u16 <a class="code" href="mip__sdk__base_8h.html#a823c12fdfee59a6f0ca8179857acc944">mip_base_cmd_reset_device</a>(<a class="code" href="struct__mip__interface.html">mip_interface</a> *device_interface);
<a name="l00135"></a>00135 
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri May 30 2014 17:03:33 for C MIP-SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
